通常情況下,Swagger 會提供一個 URL,通常以 /swagger.json 或 /swagger.yaml 結尾,用來展示 API 的定義文件。確保你可以透過瀏覽器訪問該文件。
例如:
• JSON 格式的 Swagger 文件:https://example.com/swagger.json
• YAML 格式的 Swagger 文件:https://example.com/swagger.yaml
Postman 可以直接匯入 Swagger 文件,從而自動生成 API 請求。
匯入 Swagger 文件的步驟:
1. 打開 Postman,點擊左上角的 Import 按鈕。
2. 選擇 Link 或 File。
• Link:直接貼上 Swagger JSON 或 YAML 文件的 URL(如 https://example.com/swagger.json)。
• File:如果你已經下載了 Swagger 文件,則可以選擇上傳文件。
3. 點擊 Continue,Postman 會解析 Swagger 定義並顯示 API 列表。
4. 匯入完成後,你可以在 Postman 中看到包含所有 API 端點的 Collection。
匯入 Swagger 定義後,Postman 會根據該定義自動生成請求的參數、路徑、方法等資訊。你可以按以下步驟來測試具體的 API:
1. 選擇 API 端點:在左側的 Collection 中選擇你要測試的 API 端點。
2. 設置請求參數:根據需求調整 URL、Headers、Body 等內容(若 Swagger 定義中已有預設值,這些字段會自動填充)。
3. 設置認證資訊:如果 API 需要認證(如 Bearer Token、API Key 等),可以在 Headers 或 Authorization 標籤中設置相應的認證資訊。
4. 發送請求:點擊 Send 按鈕,Postman 會發送請求並顯示返回的結果。
Postman 會展示 API 請求的響應,包括狀態碼、響應體、Headers 等資訊。你可以根據響應的內容來驗證 API 的行為。
調試與優化
• 若 API 請求失敗,Postman 的日誌功能會提供詳細的錯誤資訊,你可以根據這些資訊進一步調試 API。
• 可以通過 Postman 的 Tests 標籤編寫簡單的測試腳本,自動化測試響應數據是否符合預期。
總結
通過將 Swagger 定義文件匯入到 Postman,開發者可以快速生成並測試 API 請求,大大提高測試效率。Postman 的可視化介面和豐富的調試功能,為開發和測試人員提供了良好的支持。